POST
/
toptimize
/
v1
/
retrieval
[Beta] Retrieve objects
curl --request POST \
  --url https://api.topsort.com/toptimize/v1/retrieval \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "slots": 5,
  "opaqueUserId": "u_9ske45",
  "seedProductIds": [
    "p_PJbnN",
    "p_ojng4"
  ],
  "mode": "all",
  "deviceType": [
    "mobile"
  ]
}'
{
  "objectType": "listing",
  "objects": [
    {
      "id": "p_xh90s",
      "value": 0.978
    },
    {
      "id": "p_12lp0",
      "value": 0.953
    },
    {
      "id": "p_ds7ui",
      "value": 0.877
    }
  ],
  "error": false
}

Authorizations

​
Authorization
string
header
required

A valid API key generated in Topsort's UI.

Body

application/json

The context information for the predictions, including which metrics to predict.

​
slots
integer
required

How many objects to retrieve.

Required range: 1 <= x <= 100
Examples:

10

50

​
opaqueUserId
string
required

The opaque user ID is an anonymized unique identifier that maps to the original user ID without revealing the original value. This identifier allows Topsort to correlate user activity between auctions and user interactions, independent of the user's logged-in status. For apps or sites where users might interact while logged out, we recommend generating a random identifier (UUIDv7) on the first load, storing it on local storage (cookie, local storage, etc), and letting it live for at least a year. Otherwise, if your users are always logged in for interactions, you may use a hash of your customer ID. Correct purchase attribution requires long-lived opaque user IDs consistent between auction and event requests.

Examples:

"71303ce0-de89-496d-8270-6434589615e8"

​
objectType
enum<string>
required

The type of object that needs to be retrieved.

Available options:
listings,
banners
​
seedProductIds
string[]
required
Examples:

"p_1234"

"p_5678"

​
page
object
​
deviceType
enum<string>

The device the user is on.

Available options:
desktop,
mobile
Examples:

"mobile"

​
mode
enum<string>
default:all

Retrieval mode, how to interpret the context to get objects.

Available options:
all,
complement,
similar

Response

The retrieval results. Each retrieved products is accompanied by their relevancy score.

​
objectType
enum<string>
required

The type of object that was predicted.

Available options:
listings,
banners
​
objects
object[]
required

Retrieved objects.